home *** CD-ROM | disk | FTP | other *** search
/ MacTech 1 to 12 / MacTech-vol-1-12.toast / Source / SAT 2.4.0 & updates ƒ / SAT 2.4.0 ƒ / SAT Think Lib ƒ / SAT.h < prev    next >
Text File  |  1997-02-21  |  11KB  |  294 lines
  1. /* #include file for SAT */
  2.  
  3. #ifndef __SAT__
  4.  
  5. #define __SAT__
  6.  
  7. #pragma once
  8. #ifdef __cplusplus
  9. extern "C" {
  10. #endif
  11.  
  12. #ifdef __MWERKS__
  13. #pragma options align=mac68k
  14. #endif
  15.  
  16. #ifndef true
  17. #define true 1
  18. #endif
  19.  
  20. #ifndef false
  21. #define false 0
  22. #endif
  23.  
  24. #ifndef nil
  25. #define nil 0L
  26. #endif
  27.  
  28.     typedef struct SATPort {
  29.         GrafPtr        port;
  30.         GDHandle    device;
  31.         Ptr                rows;
  32.         Rect            bounds;
  33.         Ptr                baseAddr;
  34.         short            rowBytes;
  35.     } SATPort;
  36.  
  37.     typedef struct Face {
  38.         char            *colorData;
  39.         short            resNum;
  40.         BitMap            iconMask;
  41.         short            rowBytes; /* Note! No flags in the highest bits!*/
  42.         struct face        *next;
  43.         RgnHandle        maskRgn;
  44.         Ptr    rows, maskRows;
  45.         pascal void (*redrawProc)(struct Face *, short);    //Called on depth changes, not needed if the face is loaded from a cicn}
  46.         pascal void (*drawProc)(struct Face *, RgnHandle, SATPort *, Point srcPt, Point dstPt, short width, short height); // Untested from C so far!
  47.         } Face, *FacePtr;
  48.  
  49.     typedef struct Sprite {
  50. /* Variables that you should change as appropriate */
  51.         short            kind;
  52.         Point            position;
  53.         Rect            hotRect, hotRect2;    // Only change hotRect, SAT handles hotRect2
  54.         FacePtr            face;
  55.         pascal void        (*task) (struct Sprite *);
  56.         pascal void        (*hitTask) (struct Sprite *, struct Sprite *);
  57.         pascal void        (*destructTask) (struct Sprite *);
  58.         RgnHandle        clip; /* Clip region to be used when this sprite is drawn. */
  59. /* SAT variables that you shouldn't change: */
  60.         Point            oldpos;
  61.         struct Sprite    *next, *prev;
  62.         Rect            r, oldr;
  63.         FacePtr        oldFace;            //Used by RunSAT2
  64.         Boolean        dirty;        //Used by RunSAT2
  65. /* Variables for free use by the application: */
  66.         short        layer;
  67. #ifdef SATCPP_H
  68.       Ptr            spriteBegin;
  69. #else
  70.         Point            speed;
  71.         short        mode;
  72.         Ptr            appPtr;
  73.         long            appLong;
  74. #endif
  75.         } Sprite, *SpritePtr;
  76.  
  77.  
  78. typedef struct{
  79.         short    patternType;     /* 1 = Pattern, PatHandle, 2 = PixPat, PixPatHandle */
  80.         PixPatHandle    thePat;         /* or PatHandle */
  81.         }    SATPattern, *SATPatPtr, **SATPatHandle;
  82.  
  83. #define    UpdatePtr    Ptr
  84.  
  85. typedef struct {
  86.         SATPort        wind;
  87.         short            offSizeH, offSizeV;
  88.         SATPort        offScreen, backScreen;
  89.         long            ox, oy;
  90.         short            pict, bwpict;
  91.         Boolean        fitThePICTs;
  92.         short            sorting, collision, searchWidth;
  93.         PixMapHandle    screen;
  94.         Rect            bounds;
  95.         short            initDepth;
  96.         pascal Boolean    (*synchHook) ();
  97.         SpritePtr        sRoot;
  98.         UpdatePtr        updateRoot;
  99.         Boolean        anyMonsters;
  100.  
  101.         CGrafPtr        ditherOff;
  102.         GDHandle        ditherOffGD;
  103.         SATPort            iconPort;
  104.         SATPort            iconPort2;
  105.         GrafPtr            bwIconPort;
  106.  
  107. /* Environment-independent globals: */
  108.         FacePtr            faceRoot;    /* Face list */
  109.         Boolean            colorFlag; /* Is this Mac color capable? */
  110. /*Blitters! You should not change these fields yourself. (Possibly for installing a blitter in your program code.)*/
  111.         ProcPtr    rectBlit1, maskBlit1;                //{Supplied - this is either RBlt/MBlt 0 or 1}
  112.         ProcPtr    rectBlit2, maskBlit2;                //{Will probably never be used}
  113.         ProcPtr    rectBlit4, maskBlit4;                //{Supplied}
  114.         ProcPtr    rectBlit8, maskBlit8;                //{Supplied}
  115.         ProcPtr    rectBlit16, maskBlit16;            //{Not supplied}
  116.         ProcPtr    rectBlit32, maskBlit32;            //{Not supplied}
  117.         ProcPtr    curRectBlit, curMaskBlit;        //{Currently selected fast blitter}
  118.  
  119.         Rect    screenLocalDrawingArea;
  120.         SpritePtr    trashList;
  121.         } SATglobalsRec;
  122.  
  123. /* Constants for SATConfigure */
  124.     enum{kVPositionSort=0, kLayerSort, kNoSort};
  125.     enum{kKindCollision=0, kForwardCollision, kBackwardCollision, kNoCollision, kForwardOneCollision};
  126.  
  127. // For CodeWarrior C, 68k (due to capitalization problems):
  128. // Note: If you have link problems associated with gSAT, you may have
  129. // to activate or deactivate this #define!
  130. #ifdef __MWERKS__
  131. #ifndef powerc
  132. #define gSAT GSAT
  133. #endif
  134. #endif
  135.  
  136. /* Global variables */
  137.     extern SATglobalsRec    gSAT;    /* Most globals */
  138.     extern pascal void        (*gSoundErrorProc)(OSErr); /* Sound errors reported here */
  139.  
  140. /* SAT routines */
  141.  
  142.     typedef pascal void (*TaskPtr)(SpritePtr);
  143.     typedef pascal Boolean (*SynchPtr)(void);
  144.     typedef pascal void (*EmergencyPtr)(void);
  145.  
  146. /* Initialization */
  147.     pascal void SATConfigure(Boolean, short, short, short);
  148.     pascal void SATInit (short, short, short, short);
  149.     pascal void SATCustomInit (short, short, Rect *, WindowPtr, GDHandle, Boolean, Boolean, Boolean, Boolean, Boolean);
  150. /* Maintainance, background manipulation etc. */
  151.     pascal Boolean SATDepthChangeTest(void);
  152.     pascal void SATDrawPICTs (short, short);
  153.     pascal void SATRedraw(void);
  154. /* Drawing */
  155.     pascal void SATPlotFace(FacePtr, SATPort*, Point, Boolean); /*Draw a Face (icon).*/
  156.     pascal void SATPlotFaceToScreen(FacePtr, Point, Boolean);
  157.     pascal void SATCopyBits(SATPort*, SATPort*, GDHandle, Rect*, Rect*, Boolean);
  158.     pascal void SATCopyBitsToScreen(SATPort*, Rect*, Rect*, Boolean);
  159.     pascal void SATBackChanged (Rect *); /*Tell SAT about changes in BackScreen*/
  160. /* SetPort replacements */
  161.     pascal void SATGetPort (SATPort*);
  162.     pascal void SATSetPort (SATPort*);
  163.     pascal void SATSetPortOffScreen(void); /*Use before Quick-Drawing on offScreen*/
  164.     pascal void SATSetPortBackScreen(void); /*Use before Quick-Drawing on BackScreen*/
  165.     pascal void SATSetPortScreen(void); /*Use to restore after drawing off/backscreen*/
  166. /* Sprite handling */
  167.     pascal FacePtr SATGetFace (short);
  168.     pascal void SATDisposeFace (FacePtr);
  169.     pascal SpritePtr SATNewSprite (short,short,short, TaskPtr); // (*void)(SpritePtr));
  170.     pascal SpritePtr SATNewSpriteAfter (SpritePtr,short,short,short, TaskPtr);
  171.     pascal void SATKillSprite (SpritePtr);
  172. /* Animating */
  173.     pascal void SATRun (Boolean);
  174.     pascal void    SATRun2 (Boolean); //Alternate routine for allowing resting sprites}
  175. /* Advanced special-purpose calls */
  176.     pascal void SATInstallSynch (SynchPtr);
  177.     pascal void SATInstallEmergency (EmergencyPtr);
  178.     pascal void SATSetSpriteRecSize (long);
  179.     pascal void SATSkip(void);
  180.     pascal void SATKill(void); /*Dispose of offscreen buffers to allow re-init*/
  181.     pascal void SATWindMoved(void);            /* For programs with moveable animation window and fast animation */
  182. /* Offscreen - use only if you need an *extra* offscreen buffer. These calls are likely to change in the future!*/
  183.     pascal void SATMakeOffscreen (SATPort*, Rect*);    /*Make offscreen buffer in current screen depth and CLUT.*/
  184.     pascal void SATDisposeOffScreen (SATPort*);        /*Get rid of offscreen*/
  185.     pascal OSErr CreateOffScreen (Rect*, short, CTabHandle, CGrafPtr*, GDHandle*); /*From Principia Offscreen*/
  186.     pascal void DisposeOffScreen (CGrafPtr, GDHandle);            /*From Principia Offscreen*/
  187. /* Face manipulation */
  188.     pascal void SATSetPortMask (FacePtr);
  189.     pascal void SATSetPortFace (FacePtr);
  190.     pascal void SATSetPortFace2 (FacePtr);
  191.     pascal FacePtr SATNewFace (Rect*);
  192.     pascal void SATChangedFace (FacePtr);
  193.  
  194. /* Most common old names, uncomment for compatibility with old programs */
  195. // #define ConfigureSAT        SATConfigure
  196. // #define InitSAT            SATInit
  197. // #define CustomInitSAT    SATCustomInit
  198. // #define KillSAT            SATKill
  199. // #define RunSAT            SATRun
  200. // #define SkipSAT            SATSkip
  201. // #define GetFace            SATGetFace
  202. // #define DisposeFace        SATDisposeFace
  203. // #define NewSprite        SATNewSprite
  204. // #define NewSpriteAfter    SATNewSpriteAfter
  205. // #define KillSprite        SATKillSprite
  206. // #define NewFace            SATNewFace
  207. // #define ChangedFace        SATChangedFace
  208. // #define PeekOffscreen    SATRedraw
  209.  
  210. // "Safe" blitter routines, using QuickDraw.
  211. pascal void SATSafeRectBlit(SATPort *srcPort, SATPort *dstPort, Rect *r);
  212. pascal void SATSafeMaskBlit(FacePtr face, SpritePtr theSprite, SATPort *dstPort, Point srcPt,Point dstPt,short width,short height);
  213.  
  214. /* New procedures, EXPERIMENTAL, intended for making a C++ interface */
  215.     pascal SpritePtr SATNewSpritePP(SpritePtr, Ptr, short, short, short, TaskPtr);
  216.     pascal void SATCopySprite(SpritePtr, const Sprite *);
  217. //    pascal void SATCopySprite(SpritePtr, SpritePtr);
  218.     pascal FacePtr SATNewFacePP(Rect*, Ptr);
  219.     pascal FacePtr SATGetFacePP (short, Ptr);
  220.     pascal void SATCopyFace(FacePtr, const Face *);
  221. //    pascal void SATCopyFace(FacePtr, FacePtr);
  222.     pascal void SATDisposeFacePP (FacePtr);
  223.  
  224. /* Cicn utilities */
  225.     pascal CIconHandle SATGetCicn (short);
  226.     pascal void SATPlotCicn (CIconHandle, GrafPtr, GDHandle, Rect*);
  227.     pascal void SATDisposeCicn (CIconHandle);
  228.  
  229. /*Utilities*/
  230.     pascal void SATSetStrings (Str255, Str255, Str255, Str255, Str255, Str255, Str255, Str255);
  231.     pascal Boolean SATTrapAvailable (short);
  232.     pascal void SATDrawInt (short);
  233.     pascal void SATDrawLong (long);
  234.     pascal short SATRand (short);
  235.     pascal short SATRand10(void);
  236.     pascal short SATRand100(void);
  237.     pascal void SATReportStr (Str255);
  238.     pascal Boolean SATQuestionStr(Str255);
  239.     pascal void CheckNoMem (Ptr); /*If the Ptr is nil, out of memory emergency exit*/
  240.     pascal short SATFakeAlert (Str255, Str255, Str255, Str255, short, short, short, Str255, Str255, Str255);
  241.     pascal void SATSetMouse (Point);
  242.     pascal void SATInitToolbox(void);
  243.     pascal void SATGetVersion(Str255 versionString);
  244. /* Pattern utilities */
  245.     pascal void SATPenPat (SATPatHandle);
  246.     pascal void SATBackPat (SATPatHandle);
  247.     pascal SATPatHandle SATGetPat (short);
  248.     pascal void SATDisposePat (SATPatHandle);
  249. /* Menu bar utilities */
  250.     pascal void SATShowMBar(WindowPtr);
  251.     pascal void SATHideMBar(WindowPtr);
  252. /* PICT utilities */
  253.     pascal void SATGetandDrawPICTRes (short id);
  254.     pascal void SATGetandDrawPICTResInRect (short id, Rect *frame);
  255.     pascal void SATGetandCenterPICTResInRect (short id, Rect *frame);
  256. /*Sound*/
  257.     pascal void SATInitSound(void);            /* No longer necessary */
  258.     pascal void SATSoundPlay (Handle, short, Boolean);    /* Play sounds with priority handling */
  259.     pascal void SATSoundShutup(void);        /*Silence, dispose of sound channel*/
  260.     pascal void SATSoundEvents(void);        /* Call this once in a while when not calling RunSAT often */
  261.     pascal Boolean SATSoundDone(void);    /* Any sound going on?*/
  262.     pascal Handle SATGetSound (short);
  263.     pascal Handle SATGetNamedSound (Str255);
  264.     pascal void SATDisposeSound (Handle);
  265.     pascal void SATSoundOn(void);
  266.     pascal void SATSoundOff(void);
  267. /* Multi-channel sound routines */
  268.     pascal short SATSoundInitChannels (short);
  269.     pascal Boolean SATSoundDoneChannel (short);
  270.     pascal void SATSoundPlayChannel (Handle, short);
  271.     pascal void SATSoundReserveChannel (short, Boolean);
  272.     pascal void SATSoundShutupChannel (short);
  273.     pascal void SATPreloadChannels(void);
  274. /* Experimental, likely to be renamed/removed/changed: */
  275.     pascal void SATSoundPlay2 (Handle, short, Boolean,Boolean);
  276.     pascal void SATSoundPlayEasy (Handle, Boolean);
  277. /* More multi-channel: */
  278.     pascal int SATGetNumChannels(void);
  279.     pascal Ptr SATGetChannel (int);
  280. /* Customization */
  281.     pascal void SATSetSoundInitParams (long);
  282. /* Step-scrolling */
  283.     pascal Boolean SATStepScroll (Point viewPoint, short marginH, short marginV, short scrollSpeed);
  284.  
  285. #ifdef __MWERKS__
  286. #pragma options align=reset
  287. #endif
  288.  
  289. #ifdef __cplusplus
  290. }
  291. #endif
  292.  
  293. #endif
  294.